/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.exception;

/**
 * Thrown when an invalid property is added to an instance of 
 * {@code ElementProperties}.
 * 
 * @author 		Schnell Michaël
 * @version		1.0
 */
public class InvalidPropertyException extends KameleonException {

	/**
	 * Needed to serialize this class.
	 * 
	 * @see		java.io.Serializable
	 */
	private static final long serialVersionUID = 4098938154740967191L ;

	/**
	 * Error message displayed for a {@code null} property key.
	 */
	private static final String PROPERTY_NAME_NULL 
		= "The property key cannot be null." ;//$NON-NLS-1$

	/**
	 * Error message displayed for a {@code null} property value.
	 */
	private static final String PROPERTY_VALUE_NULL 
		= "The property value for '%s' cannot be null." ;//$NON-NLS-1$

	/**
	 * Error message displayed by default.
	 */
	private static final String DEFAULT_INVALID_PROPERTY
		= "Invalid property." ;//$NON-NLS-1$

	/**
	 * Builds a {@code InvalidPropertyException} with a default error message.
	 */
	public InvalidPropertyException() {
		this(DEFAULT_INVALID_PROPERTY) ;
	}// InvalidPropertyException()

	/**
	 * Builds a {@code InvalidPropertyException} with a formatted error message.
	 * 
	 * @param 	propertyKey
	 * 			name of the property which caused the exception
	 */
	public InvalidPropertyException(String propertyKey) {
		super(getErrorMessage(propertyKey)) ;
	}// InvalidPropertyException(String)

	/**
	 * Creates the error message displayed when an invalid property is added.
	 * 
	 * @param 	propertyKey
	 * 			name of the property which caused the exception
	 * 
	 * @return	Error message displayed by this exception
	 */
	private static final String getErrorMessage(String propertyKey) {
		if (propertyKey == null) {
			return PROPERTY_NAME_NULL ;
		}// if
		return String.format(PROPERTY_VALUE_NULL, propertyKey) ;
	}// getErrorMessage(String)

}// class InvalidPropertyException